docs: Say what correct can and can't repair - #102
BenWestgate wants to merge 1 commit into
Conversation
A tester called correction a black box: the user guide gave it one paragraph and the limits were only in the developer API guide. List what one string can survive and what it can't, plus the 13-fill case that the YES prompt guards. Each limit was checked by damaging BIP-93 test vectors and running the correction search, 2 to 4 trials per case. Closes #89 Claude-Session: https://claude.ai/code/session_015CuLXqAvAovfoVcUmmogwa
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
BenWestgate
left a comment
There was a problem hiding this comment.
AI-generated review (Codex), posted at the maintainer's request.
ACK 4a0b18b. The capability documentation matches the implemented correction behavior.
|
V1 disposition (Codex, 2026-10-04): defer this post-audit correction-capability documentation from the v1 candidate. The docs have a current-head Codex ACK and are useful, but they document follow-up field testing rather than closing a validated finding from the supplied adversarial reviews. The v1 user-facing audit fixes already include the reviewed mixed-case correction behavior and the length-specific recovery guidance. Keep #102 open for post-v1 so the frozen review candidate stops accumulating late documentation scope. Human authorship/review remains required when integrated. |
Requested by Ben · project thread
Before: the user guide gave
correctone paragraph, and its limits were only in the developer API guide.After: a "What
correctcan repair" section in the user guide lists what one string survives, what it doesn't, when to add--bytes 32, and why filling exactly 13 unreadable characters needsYES.How: each limit was measured by damaging BIP-93 test vectors (48, 74 and 127 characters) and running the CLI's correction search, 2 to 4 trials per case, on #57's branch, with the 48-character cases repeated on
reviewability-v1. Two items from the issue's starting list didn't hold and are left out: 2 missing plus 2 extra worked in only half the trials within ten seconds, and 3 missing plus 1 extra and two wrong groups never did. Script and results:limits.pyandresults-pr57-branch.txtin the project'scorrect-limitsfolder.Docs only. Closes #89
🤖 Generated with Claude Code
https://claude.ai/code/session_015CuLXqAvAovfoVcUmmogwa
Generated by Claude Code